<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.ant.clover;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Date;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.HashMap;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import javax.xml.bind.JAXBContext;<a name="line.7"></a>
<FONT color="green">008</FONT>    import javax.xml.bind.JAXBException;<a name="line.8"></a>
<FONT color="green">009</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.9"></a>
<FONT color="green">010</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    import org.apache.tools.ant.BuildException;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.hackystat.sensor.ant.clover.jaxb.Coverage;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.hackystat.sensor.ant.clover.jaxb.File;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.sensor.ant.clover.jaxb.Metrics;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.sensor.ant.clover.jaxb.Package;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.sensor.ant.clover.jaxb.Project;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.hackystat.sensor.ant.task.HackystatSensorTask;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.hackystat.sensor.ant.util.JavaClass2FilePathMapper;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.hackystat.sensor.ant.util.LongTimeConverter;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.hackystat.sensorshell.SensorShellException;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    /**<a name="line.23"></a>
<FONT color="green">024</FONT>     * Implements an Ant task that parses the XML files generated by the Clover coverage tool and <a name="line.24"></a>
<FONT color="green">025</FONT>     * sends the data to a Hackystat server.<a name="line.25"></a>
<FONT color="green">026</FONT>     *<a name="line.26"></a>
<FONT color="green">027</FONT>     * @author Aaron A. Kagawa, Philip Johnson<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public class CloverSensor extends HackystatSensorTask {<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>      /** The mapper used to map class names to file paths. */<a name="line.31"></a>
<FONT color="green">032</FONT>      private JavaClass2FilePathMapper javaClass2FilePathMapper;<a name="line.32"></a>
<FONT color="green">033</FONT>      <a name="line.33"></a>
<FONT color="green">034</FONT>      /** The name of this tool. */<a name="line.34"></a>
<FONT color="green">035</FONT>      private static String tool = "Clover";<a name="line.35"></a>
<FONT color="green">036</FONT>      <a name="line.36"></a>
<FONT color="green">037</FONT>      /** Initialize a new instance of a CloverSensor. */<a name="line.37"></a>
<FONT color="green">038</FONT>      public CloverSensor() {<a name="line.38"></a>
<FONT color="green">039</FONT>        super(tool);<a name="line.39"></a>
<FONT color="green">040</FONT>      }<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>      /**<a name="line.42"></a>
<FONT color="green">043</FONT>       * Initialize a new instance of a CloverSensor, passing the host and directory <a name="line.43"></a>
<FONT color="green">044</FONT>       *   key in explicitly. This supports testing. Note that when this constructor <a name="line.44"></a>
<FONT color="green">045</FONT>       *   is called, offline data recovery by the sensor is disabled.<a name="line.45"></a>
<FONT color="green">046</FONT>       * @param host The hackystat host URL.<a name="line.46"></a>
<FONT color="green">047</FONT>       * @param email The Hackystat email to use.<a name="line.47"></a>
<FONT color="green">048</FONT>       * @param password The Hackystat password to use.<a name="line.48"></a>
<FONT color="green">049</FONT>       */<a name="line.49"></a>
<FONT color="green">050</FONT>      public CloverSensor(String host, String email, String password) {<a name="line.50"></a>
<FONT color="green">051</FONT>        super(host, email, password, tool);<a name="line.51"></a>
<FONT color="green">052</FONT>      }<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>      /**<a name="line.54"></a>
<FONT color="green">055</FONT>       * Parses the Coverage XML files and sends the resulting coverage results to<a name="line.55"></a>
<FONT color="green">056</FONT>       * the hackystat server. This method is invoked automatically by Ant.<a name="line.56"></a>
<FONT color="green">057</FONT>       * @throws BuildException If there is an error.<a name="line.57"></a>
<FONT color="green">058</FONT>       */<a name="line.58"></a>
<FONT color="green">059</FONT>      @Override<a name="line.59"></a>
<FONT color="green">060</FONT>      public void executeInternal() throws BuildException {<a name="line.60"></a>
<FONT color="green">061</FONT>        this.setupSensorShell();<a name="line.61"></a>
<FONT color="green">062</FONT>        int numberOfEntries = 0;<a name="line.62"></a>
<FONT color="green">063</FONT>        Date startTime = new Date();<a name="line.63"></a>
<FONT color="green">064</FONT>        <a name="line.64"></a>
<FONT color="green">065</FONT>        for (java.io.File dataFile : getDataFiles()) {<a name="line.65"></a>
<FONT color="green">066</FONT>          verboseInfo("Processing Clover file: " + dataFile);<a name="line.66"></a>
<FONT color="green">067</FONT>          try {<a name="line.67"></a>
<FONT color="green">068</FONT>            numberOfEntries += this.processCoverageXmlFile(dataFile);<a name="line.68"></a>
<FONT color="green">069</FONT>          }<a name="line.69"></a>
<FONT color="green">070</FONT>          catch (Exception e) {<a name="line.70"></a>
<FONT color="green">071</FONT>            signalError("Failure processing Clover file: " + dataFile, e);<a name="line.71"></a>
<FONT color="green">072</FONT>          }<a name="line.72"></a>
<FONT color="green">073</FONT>        }<a name="line.73"></a>
<FONT color="green">074</FONT>        this.sendAndQuit();<a name="line.74"></a>
<FONT color="green">075</FONT>        summaryInfo(startTime, "Coverage", numberOfEntries);<a name="line.75"></a>
<FONT color="green">076</FONT>      }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>      /**<a name="line.78"></a>
<FONT color="green">079</FONT>       * Parses an Clover XML file and sends the data to the shell. The only coverage information that <a name="line.79"></a>
<FONT color="green">080</FONT>       * is used by the sensor is the Clover class level report. All other coverage information is <a name="line.80"></a>
<FONT color="green">081</FONT>       * ignored; for example the sensor does not use the method element coverage information. <a name="line.81"></a>
<FONT color="green">082</FONT>       * Instead, the sensor parses the class element. Here is an example: <a name="line.82"></a>
<FONT color="green">083</FONT>       * &lt;pre&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>       * &lt;file name="PmdSensor.java"&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>       *   &lt;class name="PmdSensor"&gt;<a name="line.85"></a>
<FONT color="green">086</FONT>       *     &lt;metrics methods="18" conditionals="36" coveredstatements="77" coveredmethods="7" <a name="line.86"></a>
<FONT color="green">087</FONT>       *       coveredconditionals="11" statements="141" coveredelements="95" elements="195"/&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>       *   &lt;/class&gt;<a name="line.88"></a>
<FONT color="green">089</FONT>       *   &lt;metrics classes="1" methods="18" conditionals="36" ncloc="270" coveredstatements="77" <a name="line.89"></a>
<FONT color="green">090</FONT>       *     coveredmethods="7" coveredconditionals="11" statements="141" loc="456" <a name="line.90"></a>
<FONT color="green">091</FONT>       *     coveredelements="95" elements="195"/&gt;<a name="line.91"></a>
<FONT color="green">092</FONT>       *   ...<a name="line.92"></a>
<FONT color="green">093</FONT>       * &lt;/file&gt;<a name="line.93"></a>
<FONT color="green">094</FONT>       * &lt;/pre&gt; <a name="line.94"></a>
<FONT color="green">095</FONT>       * The granularities of file metrics element.  One could dig down into the line elements but <a name="line.95"></a>
<FONT color="green">096</FONT>       * we aren't doing that now.   <a name="line.96"></a>
<FONT color="green">097</FONT>       * <a name="line.97"></a>
<FONT color="green">098</FONT>       * @param xmlFile The XML file name to be processed.<a name="line.98"></a>
<FONT color="green">099</FONT>       * @exception BuildException if any error.<a name="line.99"></a>
<FONT color="green">100</FONT>       * @return The number of coverage entries in this XML file.<a name="line.100"></a>
<FONT color="green">101</FONT>       */<a name="line.101"></a>
<FONT color="green">102</FONT>      public int processCoverageXmlFile(java.io.File xmlFile) throws BuildException {<a name="line.102"></a>
<FONT color="green">103</FONT>        XMLGregorianCalendar runtimeGregorian = LongTimeConverter.convertLongToGregorian(this.runtime);<a name="line.103"></a>
<FONT color="green">104</FONT>        // The start time for all entries will be approximated by the XML file's last mod time.<a name="line.104"></a>
<FONT color="green">105</FONT>        // The shell will ensure that it's unique by tweaking the millisecond field.<a name="line.105"></a>
<FONT color="green">106</FONT>        long startTime = xmlFile.lastModified();<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        try {<a name="line.109"></a>
<FONT color="green">110</FONT>          JAXBContext context = <a name="line.110"></a>
<FONT color="green">111</FONT>            JAXBContext.newInstance(org.hackystat.sensor.ant.clover.jaxb.ObjectFactory.class);<a name="line.111"></a>
<FONT color="green">112</FONT>          Unmarshaller unmarshaller = context.createUnmarshaller();<a name="line.112"></a>
<FONT color="green">113</FONT>          <a name="line.113"></a>
<FONT color="green">114</FONT>          // clover report<a name="line.114"></a>
<FONT color="green">115</FONT>          Coverage coverage = (Coverage) unmarshaller.unmarshal(xmlFile);<a name="line.115"></a>
<FONT color="green">116</FONT>          Project project = coverage.getProject();<a name="line.116"></a>
<FONT color="green">117</FONT>          <a name="line.117"></a>
<FONT color="green">118</FONT>          int coverageEntriesCount = 0;<a name="line.118"></a>
<FONT color="green">119</FONT>          for (Package packageReport : project.getPackage()) {<a name="line.119"></a>
<FONT color="green">120</FONT>            String packageName = packageReport.getName();<a name="line.120"></a>
<FONT color="green">121</FONT>            <a name="line.121"></a>
<FONT color="green">122</FONT>            for (File file : packageReport.getFile()) {<a name="line.122"></a>
<FONT color="green">123</FONT>              String fileName = file.getName();<a name="line.123"></a>
<FONT color="green">124</FONT>              Metrics metrics = file.getMetrics();<a name="line.124"></a>
<FONT color="green">125</FONT>              String className = file.getClazz().getName();<a name="line.125"></a>
<FONT color="green">126</FONT>              String javaClassName = packageName + '.' + className;<a name="line.126"></a>
<FONT color="green">127</FONT>              String javaSourceFilePath = fileName;<a name="line.127"></a>
<FONT color="green">128</FONT>              // for some reason sometimes file names can be fully qualified. <a name="line.128"></a>
<FONT color="green">129</FONT>              // not sure how to configure clover to do that. if its not fully <a name="line.129"></a>
<FONT color="green">130</FONT>              // qualified then we try to use the mapping. <a name="line.130"></a>
<FONT color="green">131</FONT>              if (javaSourceFilePath.length() &lt;= (className + ".java").length()) {<a name="line.131"></a>
<FONT color="green">132</FONT>                javaSourceFilePath = this.getJavaClass2FilePathMapper().getFilePath(javaClassName);<a name="line.132"></a>
<FONT color="green">133</FONT>                if (javaSourceFilePath == null) {<a name="line.133"></a>
<FONT color="green">134</FONT>                  verboseInfo("Warning: Unable to find java source file path for class '" <a name="line.134"></a>
<FONT color="green">135</FONT>                      + javaClassName + "'. Using empty string as the resource.");<a name="line.135"></a>
<FONT color="green">136</FONT>                  javaSourceFilePath = "";<a name="line.136"></a>
<FONT color="green">137</FONT>                }<a name="line.137"></a>
<FONT color="green">138</FONT>              }<a name="line.138"></a>
<FONT color="green">139</FONT>              <a name="line.139"></a>
<FONT color="green">140</FONT>              // Alter startTime to guarantee uniqueness.<a name="line.140"></a>
<FONT color="green">141</FONT>              long uniqueTstamp = this.tstampSet.getUniqueTstamp(startTime);<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>              // Get altered start time as XMLGregorianCalendar<a name="line.143"></a>
<FONT color="green">144</FONT>              XMLGregorianCalendar startTimeGregorian = <a name="line.144"></a>
<FONT color="green">145</FONT>                LongTimeConverter.convertLongToGregorian(uniqueTstamp);<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>              Map&lt;String, String&gt; keyValMap = new HashMap&lt;String, String&gt;();<a name="line.147"></a>
<FONT color="green">148</FONT>              keyValMap.put("Tool", "Clover");<a name="line.148"></a>
<FONT color="green">149</FONT>              keyValMap.put("SensorDataType", "Coverage");<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>              // Required<a name="line.151"></a>
<FONT color="green">152</FONT>              keyValMap.put("Runtime", runtimeGregorian.toString());<a name="line.152"></a>
<FONT color="green">153</FONT>              keyValMap.put("Timestamp", startTimeGregorian.toString());<a name="line.153"></a>
<FONT color="green">154</FONT>              keyValMap.put("Resource", javaSourceFilePath);<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>              // Optional<a name="line.156"></a>
<FONT color="green">157</FONT>              keyValMap.put("ClassName", javaClassName);<a name="line.157"></a>
<FONT color="green">158</FONT>                            <a name="line.158"></a>
<FONT color="green">159</FONT>              int total = metrics.getConditionals();<a name="line.159"></a>
<FONT color="green">160</FONT>              int covered = metrics.getCoveredconditionals();<a name="line.160"></a>
<FONT color="green">161</FONT>              keyValMap.put("conditional_Covered", String.valueOf(covered));<a name="line.161"></a>
<FONT color="green">162</FONT>              keyValMap.put("conditional_Uncovered", String.valueOf(total - covered));<a name="line.162"></a>
<FONT color="green">163</FONT>              <a name="line.163"></a>
<FONT color="green">164</FONT>              total = metrics.getElements();<a name="line.164"></a>
<FONT color="green">165</FONT>              covered = metrics.getCoveredelements();<a name="line.165"></a>
<FONT color="green">166</FONT>              keyValMap.put("element_Covered", String.valueOf(covered));<a name="line.166"></a>
<FONT color="green">167</FONT>              keyValMap.put("element_Uncovered", String.valueOf(total - covered));<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>              total = metrics.getStatements();<a name="line.169"></a>
<FONT color="green">170</FONT>              covered = metrics.getCoveredstatements();<a name="line.170"></a>
<FONT color="green">171</FONT>              keyValMap.put("statement_Covered", String.valueOf(covered));<a name="line.171"></a>
<FONT color="green">172</FONT>              keyValMap.put("statement_Uncovered", String.valueOf(total - covered));<a name="line.172"></a>
<FONT color="green">173</FONT>    <a name="line.173"></a>
<FONT color="green">174</FONT>              total = metrics.getMethods();<a name="line.174"></a>
<FONT color="green">175</FONT>              covered = metrics.getCoveredmethods();<a name="line.175"></a>
<FONT color="green">176</FONT>              keyValMap.put("method_Covered", String.valueOf(covered));<a name="line.176"></a>
<FONT color="green">177</FONT>              keyValMap.put("method_Uncovered", String.valueOf(total - covered));<a name="line.177"></a>
<FONT color="green">178</FONT>    <a name="line.178"></a>
<FONT color="green">179</FONT>              // add data to sensorshell<a name="line.179"></a>
<FONT color="green">180</FONT>              this.sensorShell.add(keyValMap); <a name="line.180"></a>
<FONT color="green">181</FONT>              coverageEntriesCount++;<a name="line.181"></a>
<FONT color="green">182</FONT>            }<a name="line.182"></a>
<FONT color="green">183</FONT>          }<a name="line.183"></a>
<FONT color="green">184</FONT>          return coverageEntriesCount;<a name="line.184"></a>
<FONT color="green">185</FONT>        }<a name="line.185"></a>
<FONT color="green">186</FONT>        catch (JAXBException e) {<a name="line.186"></a>
<FONT color="green">187</FONT>          throw new BuildException(errMsgPrefix + "Failure in JAXB " + xmlFile, e);<a name="line.187"></a>
<FONT color="green">188</FONT>        }<a name="line.188"></a>
<FONT color="green">189</FONT>        catch (SensorShellException f) {<a name="line.189"></a>
<FONT color="green">190</FONT>          throw new BuildException(errMsgPrefix + "Failure in SensorShell " + xmlFile, f);<a name="line.190"></a>
<FONT color="green">191</FONT>        }<a name="line.191"></a>
<FONT color="green">192</FONT>      }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>      /**<a name="line.194"></a>
<FONT color="green">195</FONT>       * Get a java class to file path mapper.<a name="line.195"></a>
<FONT color="green">196</FONT>       * @return The mapper.<a name="line.196"></a>
<FONT color="green">197</FONT>       */<a name="line.197"></a>
<FONT color="green">198</FONT>      private JavaClass2FilePathMapper getJavaClass2FilePathMapper() {<a name="line.198"></a>
<FONT color="green">199</FONT>        if (this.javaClass2FilePathMapper == null) {<a name="line.199"></a>
<FONT color="green">200</FONT>          this.javaClass2FilePathMapper = new JavaClass2FilePathMapper(this.getSourceFiles());<a name="line.200"></a>
<FONT color="green">201</FONT>        }<a name="line.201"></a>
<FONT color="green">202</FONT>        return this.javaClass2FilePathMapper;<a name="line.202"></a>
<FONT color="green">203</FONT>      }<a name="line.203"></a>
<FONT color="green">204</FONT>      <a name="line.204"></a>
<FONT color="green">205</FONT>    }<a name="line.205"></a>




























































</PRE>
</BODY>
</HTML>
